/*
 * Copyright (C) 2010 TopCoder Inc., All Rights Reserved.
 */
package com.hercules.android.receiver.entities;

/**
 * <p>
 * A POJO contains the data of XREText resource.
 * </p>
 * 
 * @author TCSASSEMBER
 * @version 1.0
 */
public class XREText extends XREObject {
    /**
     * Represents the text to be displayed by the resource.
     */
    private String text;

    /**
     * Represents the id of the font resource to be used to display the text.
     */
    private Integer font;

    /**
     * Represents the color used to draw the text.
     */
    private Integer color;

    /**
     * Represents the text size.
     */
    private Integer size;

    /**
     * Indicates whether to display a blinking underscore character at the end
     * of the text resource.
     */
    private Boolean blinkingCursor;

    /**
     * Represents amount of vertical spacing between lines of text.
     */
    private Integer leading;

    /**
     * Default constructor. Set the default values.
     */
    public XREText() {
        super();
        text = "";
        color = 0xFF000000;
        size = 12;
        blinkingCursor = false;
        leading = 0;
    }

    /**
     * Gets the text to be displayed by the resource.
     * 
     * @return the text to be displayed by the resource
     */
    public String getText() {
        return text;
    }

    /**
     * Sets the text to be displayed by the resource.
     * 
     * @param text
     *            the text to be displayed by the resource.
     */
    public void setText(String text) {
        this.text = text;
    }

    /**
     * Gets the id of the font resource to be used to display the text.
     * 
     * @return the id of the font resource to be used to display the text.
     */
    public Integer getFont() {
        return font;
    }

    /**
     * Sets the id of the font resource to be used to display the text.
     * 
     * @param font
     *            the id of the font resource to be used to display the text.
     */
    public void setFont(Integer font) {
        this.font = font;
    }

    /**
     * Gets the color used to draw the text.
     * 
     * @return the color used to draw the text.
     */
    public Integer getColor() {
        return color;
    }

    /**
     * Sets the color used to draw the text.
     * 
     * @param color
     *            the color used to draw the text.
     */
    public void setColor(Integer color) {
        this.color = color;
    }

    /**
     * Gets the font size.
     * 
     * @return the font size
     */
    public Integer getSize() {
        return size;
    }

    /**
     * Gets the font size.
     * 
     * @param size
     *            the font size to set
     */
    public void setSize(Integer size) {
        this.size = size;
    }

    /**
     * Gets whether to display a blinking underscore character at the end of the
     * text resource.
     * 
     * @return whether to display a blinking underscore character at the end of
     *         the text resource.
     */
    public Boolean getBlinkingCursor() {
        return blinkingCursor;
    }

    /**
     * Sets whether to display a blinking underscore character at the end of the
     * text resource.
     * 
     * @param blinkingCursor
     *            whether to display a blinking underscore character at the end
     *            of the text resource.
     */
    public void setBlinkingCursor(Boolean blinkingCursor) {
        this.blinkingCursor = blinkingCursor;
    }

    /**
     * Gets amount of vertical spacing between lines of text.
     * 
     * @return amount of vertical spacing between lines of text
     */
    public Integer getLeading() {
        return leading;
    }

    /**
     * Sets amount of vertical spacing between lines of text.
     * 
     * @param leading
     *            amount of vertical spacing between lines of text
     */
    public void setLeading(Integer leading) {
        this.leading = leading;
    }

}
